package JavaDoc;

/**
 * @author 陈兆杰
 * @version 1.0.0
 * Javadoc标签：
 * Javadoc 生成 API 帮助文档
 * 文档注释
 * Javadoc 标签必须从一行的开头开始，否则将被视为普通文本。
 * Javadoc 用法格式如下：
 *      javadoc [options] [packagenames] [sourcefiles]
 *      javadoc -help   帮助
 *  [options]：
 *      -public	仅显示 public 类和成员
*       -protected	显示 protected/public 类和成员（默认值）
*       -package	显示 package/protected/public 类和成员
*       -private	显示所有类和成员
*       -d <directory>	输出文件的目标目录
*       -version	包含 @version 段
*       -author	包含 @author 段
*       -splitindex	将索引分为每个字母对应一个文件
*       -windowtitle <text>	文档的浏览器窗口标
*   示例：cmd:  javadoc -encoding UTF-8 -charset UTF-8 -author -version JavaDocTest.java
*   Javadoc常用标签：
*   @author     创建人
*   @version    版本
*   @projectName 项目名称
*   @package    包名
*   @className  类名称
*   @description    类描述
*   @createDate 创建时间
*   @updateUser 修改人
*   @updateDate 修改时间
*   @updateRemark   修改备注
*
 */
public class JavaDocTest {

     /**
     * 求输入两个参数范围以内整数的和
     * @param n 接收的第一个参数，范围起点
     * @param m 接收的第二个参数，范围终点
     * @return 两个参数范围以内整数的和
     */
    public int add(int n, int m) {
        int sum = 0;
        for (int i = n; i <= m; i++) {
            sum = sum + i;
        }
        return sum;
    }
}
